package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.EmpCertificateRequireAddDTO;
import org.jsola.hr.dto.EmpCertificateRequireUpdateDTO;
import org.jsola.hr.query.EmpCertificateRequireQuery;
import org.jsola.hr.vo.EmpCertificateRequireListVO;
import org.jsola.hr.vo.EmpCertificateRequireVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-公司员工证书所需信息")
public interface IEmpCertificateRequireControllerAPI {

    /**
     * 新增公司员工证书所需信息
     * @param empCertificateRequireAddDTO 公司员工证书所需信息新增实体
     * @return 公司员工证书所需信息展示对象
     */
    @ApiOperation(value = "新增公司员工证书所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empCertificateRequireAddDTO", dataType = "EmpCertificateRequireAddDTO", value = "新增公司员工证书所需信息", paramType = "body")
    })
    Result<EmpCertificateRequireVO> save(EmpCertificateRequireAddDTO empCertificateRequireAddDTO);


    /**
     * 修改公司员工证书所需信息
     * @param empCertificateRequireUpdateDTO 公司员工证书所需信息
     * @return 更新数量
     */
    @ApiOperation(value = "修改公司员工证书所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empCertificateRequireUpdateDTO", dataType = "EmpCertificateRequireUpdateDTO", value = "修改公司员工证书所需信息", paramType = "body")
    })
    Result<Integer> update(EmpCertificateRequireUpdateDTO empCertificateRequireUpdateDTO);




    /**
     * 删除单个公司员工证书所需信息，彻底删除
     * @param empCertificateRequireId 公司员工证书所需信息id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个公司员工证书所需信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empCertificateRequireId", dataType = "String", value = "公司员工证书所需信息id", paramType = "path")
    })
    Result<Integer> delete(String empCertificateRequireId);


    /**
     * 批量删除公司员工证书所需信息，彻底删除
     * @param empCertificateRequireIds 公司员工证书所需信息id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除公司员工证书所需信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empCertificateRequireIds", dataType = "String[]", value = "公司员工证书所需信息id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] empCertificateRequireIds);


    /**
     * 根据公司员工证书所需信息id查询公司员工证书所需信息详情
     * @param empCertificateRequireId 公司员工证书所需信息id
     * @return 公司员工证书所需信息详情
     */
    @ApiOperation(value="根据公司员工证书所需信息id查询公司员工证书所需信息详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empCertificateRequireId", dataType = "String", value = "公司员工证书所需信息id", paramType = "path")
    })
    Result<EmpCertificateRequireVO> findById(String empCertificateRequireId);


    /**
     * 查询公司员工证书所需信息
     * @param empCertificateRequireQuery 公司员工证书所需信息查询参数
     * @return page
     */
    @ApiOperation(value="查询公司员工证书所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empCertificateRequireQuery", dataType = "EmpCertificateRequireQuery", value = "公司员工证书所需信息查询参数", paramType = "query")
    })
    Result<List<EmpCertificateRequireListVO>> listAll(EmpCertificateRequireQuery empCertificateRequireQuery);


     /**
     * 分页查询公司员工证书所需信息
     * @param empCertificateRequireQuery 公司员工证书所需信息查询参数
     * @return page
     */
    @ApiOperation(value="分页查询公司员工证书所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empCertificateRequireQuery", dataType = "EmpCertificateRequireQuery", value = "公司员工证书所需信息查询参数", paramType = "query")
    })
    Result<Page<EmpCertificateRequireListVO>> page(EmpCertificateRequireQuery empCertificateRequireQuery);


}

